is-directory

What is is-directory?

The 'is-directory' npm package is a simple utility that allows developers to check if a given path is a directory. It provides a straightforward API for synchronous and asynchronous checks, making it useful in various file system operations where such validation is necessary.

What are is-directory's main functionalities?

Synchronous Directory Check

This feature allows you to synchronously check if a specified path is a directory. It is useful when you need an immediate result and are working in a synchronous code context.

const isDirectory = require('is-directory');
const result = isDirectory.sync('/path/to/directory');
console.log(result); // outputs true if path is a directory, false otherwise

Asynchronous Directory Check

This feature provides an asynchronous method to check if a path is a directory. It is particularly useful in non-blocking environments where operations should not interrupt the main application flow.

const isDirectory = require('is-directory');
isDirectory('/path/to/directory', function(err, dir) {
  if (err) throw err;
  console.log(dir); // outputs true if path is a directory, false otherwise
});

Other packages similar to is-directory

fs-extra

fs-extra is an extension of the native 'fs' module in Node.js. It includes additional methods like 'ensureDir' which can be used to check if a directory exists and create it if it doesn't. This package offers more comprehensive file system operations compared to 'is-directory' which focuses only on directory checking.

node-dir

node-dir provides utilities for reading directories, files, and their paths. It can check if a path is a directory, but it also includes capabilities to read directories recursively, which is not a feature of 'is-directory'. This makes node-dir suitable for applications that require more than just directory checking.

README

is-directory

Extends stats.isDirectory(), returns true if a filepath is a directory.

Install

Install with npm:

npm i is-directory --save-dev

Run tests

npm test

Usage

var isDir = require('is-directory');

isDir('README.md');
//=> 'false'
isDir('test');
//=> 'true'


function isFile(filepath) {
  return !isDir(filepath);
}
isFile('README.md');
//=> true

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert
Released under the MIT license

---

This file was generated by verb on November 17, 2014.